All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.accessibility.AccessibleRole

java.lang.Object
   |
   +----com.sun.java.accessibility.AccessibleBundle
           |
           +----com.sun.java.accessibility.AccessibleRole

public class AccessibleRole

extends AccessibleBundle

Class AccessibleRole determines the role of a component. The role of a component describes the components generic function, such as "push button," "table," or "list."

The toDisplayString method allows you to obtain the localized string for a locale independent key from a predefined ResourceBundle for the keys defined in this class.

The constants in this class present a strongly typed enumeration of common object roles. A public constructor for this class has been purposely omitted and applications should use one of the constants from this class. If the constants in this class are not sufficient to describe the role of an object, a subclass should be generated from this class and it should provide constants in a similar manner.

ALERT

Object is used to alert the user about something.

AWT_COMPONENT

An AWT component, but nothing else is known about it.

CHECK_BOX

A choice that can be checked or unchecked and provides a separate indicator indicating the current state.

COLUMN_HEADER

The header for a column of data.

COMBO_BOX

A list of choices the user can select from.

DESKTOP_ICON

An iconified internal frame in a DESKTOP_PANE.

DESKTOP_PANE

A pane that supports internal frames and iconified versions of those internal frames.

DIALOG

A top level window with title bar and a border.

DIRECTORY_PANE

A pane that allows the user to navigate through and select the contents of a directory.

FILE_CHOOSER

A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename.

FILLER

An object that fills up space in a user interface.

FRAME

A top level window with a title bar, border, menu bar, etc.

GLASS_PANE

A pane that is guaranteed to be painted on top of all panes beneath it.

INTERNAL_FRAME

A frame-like object that is clipped by a desktop pane.

LABEL

An object used to present an icon or short string in an interface.

LAYERED_PANE

A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.

LIST

An object that presents a list of objects to user and allows the user to select one or more of them.

MENU

An object usually contained in a menu bar that contains a list of actions the user can choose from.

MENU_BAR

An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from.

MENU_ITEM

An object usually contained in a menu that presents an action the user can choose.

PAGE_TAB

An object that is a child of a page tab list.

PAGE_TAB_LIST

An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object.

PANEL

A generic container that is often used to group objects.

PASSWORD_TEXT

A text object used for passwords, or other places where the text contents is not shown visibly to the user

POPUP_MENU

A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices.

PROGRESS_BAR

An object used to indicate how much of a task has been completed.

PUSH_BUTTON

An object the user can manipulate to tell the application to do something.

RADIO_BUTTON

A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked.

ROOT_PANE

A specialized pane that has a glass pane and a layered pane as its children.

ROW_HEADER

The header for a row of data.

SCROLL_BAR

An object usually used to allow a user to incrementally view a large amount of data.

SCROLL_PANE

An object that allows a user to incrementally view a large amount of information.

SEPARATOR

An object usually contained in a menu to provide a visual and logical separation of the contents in a menu.

SLIDER

An object that allows the user to select from a bounded range.

SPLIT_PANE

A specialized panel that presents two other panels at the same time.

SWING_COMPONENT

A Swing component, but nothing else is known about it.

TABLE

An object used to present information in terms of rows and columns.

TEXT

An object that presents text to the user.

TOGGLE_BUTTON

A specialized push button that can be checked or unchecked, but does not provide a separate indicator indicating the current state.

TOOL_BAR

A bar or palette usually composed of push buttons or toggle buttons.

TOOL_TIP

An object that provides information about another object.

TREE

An object used to present hierarchical information to the user.

UNKNOWN

The object contains some Accessible information, but its role is not known.

VIEWPORT

An object usually used in a scroll pane.

WINDOW

A top level window with no title or border.

AccessibleRole(String)

Create a new AccessibleRole using the given locale independent key.

 public static final AccessibleRole ALERT

Object is used to alert the user about something.

 public static final AccessibleRole COLUMN_HEADER

The header for a column of data.

 public static final AccessibleRole COMBO_BOX

A list of choices the user can select from. Also optionally allows the user to enter a choice of their own.

 public static final AccessibleRole DESKTOP_ICON

An iconified internal frame in a DESKTOP_PANE.

See Also:

DESKTOP_PANE, INTERNAL_FRAME

 public static final AccessibleRole INTERNAL_FRAME

A frame-like object that is clipped by a desktop pane. The desktop pane, internal frame, and desktop icon objects are often used to create multiple document interfaces within an application.

See Also:

DESKTOP_ICON, DESKTOP_PANE, FRAME

 public static final AccessibleRole DESKTOP_PANE

A pane that supports internal frames and iconified versions of those internal frames.

See Also:

DESKTOP_ICON, INTERNAL_FRAME

 public static final AccessibleRole WINDOW

A top level window with no title or border.

See Also:

FRAME, DIALOG

 public static final AccessibleRole FRAME

A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application.

See Also:

DIALOG, WINDOW

 public static final AccessibleRole DIALOG

A top level window with title bar and a border. A dialog is similar to a frame, but it has fewer properties and is often used as a secondary window for an application.

See Also:

FRAME, WINDOW

 public static final AccessibleRole DIRECTORY_PANE

A pane that allows the user to navigate through and select the contents of a directory. May be used by a file chooser.

See Also:

FILE_CHOOSER

 public static final AccessibleRole FILE_CHOOSER

A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename. May use the directory pane to show the contents of a directory.

See Also:

DIRECTORY_PANE

 public static final AccessibleRole FILLER

An object that fills up space in a user interface. It is often used in interfaces to tweak the spacing between components, but serves no other purpose.

 public static final AccessibleRole LABEL

An object used to present an icon or short string in an interface.

 public static final AccessibleRole ROOT_PANE

A specialized pane that has a glass pane and a layered pane as its children.

See Also:

GLASS_PANE, LAYERED_PANE

 public static final AccessibleRole GLASS_PANE

A pane that is guaranteed to be painted on top of all panes beneath it.

See Also:

ROOT_PANE

 public static final AccessibleRole LAYERED_PANE

A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. This is usually the pane that holds the menu bar as well as the pane that contains most of the visual components in a window.

See Also:

GLASS_PANE, ROOT_PANE

 public static final AccessibleRole LIST

An object that presents a list of objects to user and allows the user to select one or more of them. A list is usually contained within a scroll pane.

See Also:

SCROLL_PANE

 public static final AccessibleRole MENU_BAR

An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from. For example, a menu bar might contain menus for "File," "Edit," and "Help."

See Also:

MENU, POPUP_MENU, LAYERED_PANE

 public static final AccessibleRole POPUP_MENU

A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices.

See Also:

MENU, MENU_ITEM

 public static final AccessibleRole MENU

An object usually contained in a menu bar that contains a list of actions the user can choose from. A menu can have any object as its children, but most often they are menu items, other menus, or rudimentary objects such as radio buttons, check boxes, or separators. For example, an application may have an "Edit" menu that contains menu items for "Cut" and "Paste."

See Also:

MENU_BAR, MENU_ITEM, SEPARATOR, RADIO_BUTTON, CHECK_BOX, POPUP_MENU

 public static final AccessibleRole MENU_ITEM

An object usually contained in a menu that presents an action the user can choose. For example, the "Cut" menu item in an "Edit" menu would be an action the user can select to cut the selected area of text in a document.

See Also:

MENU_BAR, SEPARATOR, POPUP_MENU

 public static final AccessibleRole SEPARATOR

An object usually contained in a menu to provide a visual and logical separation of the contents in a menu. For example, the "File" menu of an application might contain menu items for "Open," "Close," and "Exit," and will place a separator between "Close" and "Exit" menu items.

See Also:

MENU, MENU_ITEM

 public static final AccessibleRole PAGE_TAB_LIST

An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object. The most common mechanism is a list of tabs at the top of the panel. The children of a page tab list are all page tabs.

See Also:

PAGE_TAB

 public static final AccessibleRole PAGE_TAB

An object that is a child of a page tab list. Its sole child is the panel that is to be presented to the user when the user selects the page tab from the list of tabs in the page tab list.

See Also:

PAGE_TAB_LIST

 public static final AccessibleRole PANEL

A generic container that is often used to group objects.

 public static final AccessibleRole PROGRESS_BAR

An object used to indicate how much of a task has been completed.

 public static final AccessibleRole PASSWORD_TEXT

A text object used for passwords, or other places where the text contents is not shown visibly to the user

 public static final AccessibleRole PUSH_BUTTON

An object the user can manipulate to tell the application to do something.

See Also:

CHECK_BOX, TOGGLE_BUTTON, RADIO_BUTTON

 public static final AccessibleRole TOGGLE_BUTTON

A specialized push button that can be checked or unchecked, but does not provide a separate indicator indicating the current state.

See Also:

PUSH_BUTTON, CHECK_BOX, RADIO_BUTTON

 public static final AccessibleRole CHECK_BOX

A choice that can be checked or unchecked and provides a separate indicator indicating the current state.

See Also:

PUSH_BUTTON, TOGGLE_BUTTON, RADIO_BUTTON

 public static final AccessibleRole RADIO_BUTTON

A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked.

See Also:

PUSH_BUTTON, TOGGLE_BUTTON, CHECK_BOX

 public static final AccessibleRole ROW_HEADER

The header for a row of data.

 public static final AccessibleRole SCROLL_PANE

An object that allows a user to incrementally view a large amount of information. Its children can include scroll bars and a viewport.

See Also:

SCROLL_BAR, VIEWPORT

 public static final AccessibleRole SCROLL_BAR

An object usually used to allow a user to incrementally view a large amount of data. Usually used only by a scroll pane.

See Also:

SCROLL_PANE

 public static final AccessibleRole VIEWPORT

An object usually used in a scroll pane. It represents the portion of the entire data that the user can see. As the user manipulates the scroll bars, the contents of the viewport can change.

See Also:

SCROLL_PANE

 public static final AccessibleRole SLIDER

An object that allows the user to select from a bounded range. For example, a slider might be used to select a number between 0 and 100.

 public static final AccessibleRole SPLIT_PANE

A specialized panel that presents two other panels at the same time. Between the two panels is a divider the user can manipulate to make one panel larger and the other panel smaller.

 public static final AccessibleRole TABLE

An object used to present information in terms of rows and columns. An example might include a spreadsheet application.

 public static final AccessibleRole TEXT

An object that presents text to the user. The text is usually editable by the user as opposed to a label.

See Also:

LABEL

 public static final AccessibleRole TREE

An object used to present hierarchical information to the user. The individual nodes in the tree can be collapsed and expanded to provide selective disclosure of the tree's contents.

 public static final AccessibleRole TOOL_BAR

A bar or palette usually composed of push buttons or toggle buttons. It is often used to provide the most often used functions for an application.

 public static final AccessibleRole TOOL_TIP

An object that provides information about another object. The accessibleDescription property of the tool tip is often displayed to the user in a small "help bubble" when the user causes the mouse to hover over the object associated with the tool tip.

 public static final AccessibleRole AWT_COMPONENT

An AWT component, but nothing else is known about it.

See Also:

SWING_COMPONENT, UNKNOWN

 public static final AccessibleRole SWING_COMPONENT

A Swing component, but nothing else is known about it.

See Also:

AWT_COMPONENT, UNKNOWN

 public static final AccessibleRole UNKNOWN

The object contains some Accessible information, but its role is not known.

See Also:

AWT_COMPONENT, SWING_COMPONENT

 protected AccessibleRole(String key)

Create a new AccessibleRole using the given locale independent key. This should not be a public method. Instead, it is used to create the constants in this file to make it a strongly typed enumeration. Subclasses of this class should enforce similar policy.

Parameters:

key - the locale independent name of the role.

See Also:

toDisplayString

All Packages  Class Hierarchy  This Package  Previous  Next  Index